Further fixes to the docs, particularly the table of contents #133
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request focuses on improving the documentation structure, readability, and accuracy for the E3SM-Unified project. Key updates include the addition of new sections, restructuring existing content, and refining package details for clarity.
Documentation Restructuring and Additions:
docs/releasing/index.md), "Creating Release Candidates" (docs/releasing/creating-rcs/index.md), and "Deployment and Testing" (docs/releasing/testing/index.md) to better organize the release process and testing documentation. [1] [2] [3]creating-rcs.md,testing/overview.md) into the newly created sections, improving navigation and clarity. [1] [2]Refinement of Package Details:
docs/packages.mdto split version constraints for Python versions into separate rows, enhancing readability. Additional explanatory text was added for better understanding of the table format. [1] [2] [3] [4]Navigation and Linking Improvements:
creating-rcs/overview.mdinstead ofcreating-rcs.md). [1] [2] [3] [4]Build Process Enhancements:
docs/Makefileby adding stricter error handling (-nW --keep-going) to ensure that warnings are treated as errors.Minor Content Updates:
docs/index.mdfor better focus and removed outdated or redundant entries.docs/packages.mdfor consistency.These changes collectively improve the usability, maintainability, and accuracy of the documentation.